fix: add cy.then timeouts to cy.session #31788
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds a 20-second timeout to various internal cy.then calls within cy.session to handle cases where navigating to about:blank takes longer than expected, addressing issue [#29496]. It also updates the aut-iframe logic to resolve the promise early when the iframe element is not present and amends the CHANGELOG accordingly.
- Added a COMMAND_TIMEOUT constant to all cy.then calls used within session management.
- Updated the aut-iframe promise to resolve early when necessary.
- Updated the CHANGELOG with details of the bugfix.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/driver/src/cy/commands/sessions/index.ts | Added timeouts to multiple cy.then invocations to increase robustness during session setup and restoration. |
| packages/app/src/runner/aut-iframe.ts | Modified visitBlankPage to resolve immediately when the iframe is not available. |
| cli/CHANGELOG.md | Updated changelog to describe the bugfix for cy.session timeouts. |
cypress
|
||||||||||||||||||||||||||||||||||||||||
| Project |
cypress
|
| Branch Review |
mschile/sessions/update_timeout
|
| Run status |
|
| Run duration | 08m 40s |
| Commit |
|
| Committer | Matt Schile |
| View all properties for this run ↗︎ | |
| Test results | |
|---|---|
Failures
|
0
|
Flaky
|
0
|
Pending
|
0
|
Skipped
|
0
|
Passing
|
85
|
| View all changes introduced in this branch ↗︎ | |
UI Coverage
41.79%
|
|
|---|---|
|
Untested elements
|
36
|
|
Tested elements
|
28
|
Accessibility
91.43%
|
|
|---|---|
|
Failed rules
|
0 critical
4 serious
0 moderate
0 minor
|
|
Failed elements
|
94
|
jennifer-shehane
approved these changes
May 28, 2025
AtofStryker
approved these changes
May 28, 2025
Co-authored-by: Bill Glesias <bglesias@gmail.com>
|
Released in This comment thread has been locked. If you are still experiencing this issue after upgrading to |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Additional details
We've observed cases where the load event for navigating to
about:blankhas taken more than 4 seconds but does eventually resolve. This can cause thecy.sessioncommand to fail since we don't define our own timeouts for thecy.thencalls withincy.session. In order to resolve this issue, we are adding a timeout of 20s to the internalcy.thencalls. Long term, we will probably want to investigate removing some of the internalcy.thencalls since they may not be needed.Custom debug logs showing the
about:blankpage taking ~6s to load:Steps to test
about:blankpage to take longer than thedefaultCommandTimeoutand verified it failed before and passes with the new timeouts.How has the user experience changed?
Before:
After:
PR Tasks
cypress-documentation?type definitions?